/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.pixlib.sfe.event 
{
	import net.pixlib.events.BasicEvent;

	/**
	 * @author Romain Ecarnot
	 */
	public class LibraryStateEvent extends BasicEvent 
	{
		//--------------------------------------------------------------------
		// Event types
		//--------------------------------------------------------------------
		
		/**
		 * Defines the value of the <code>type</code> property of the event 
		 * object for a <code>onUpdateState</code> event.
		 * 
		 * <p>The properties of the event object have the following values:</p>
		 * <table class="innertable">
		 *     <tr><th>Property</th><th>Value</th></tr>
		 *     <tr>
		 *     	<td><code>type</code></td>
		 *     	<td>Dispatched event type</td>
		 *     </tr>
		 * </table>
		 * 
		 * @eventType onUpdateState
		 */
		public static const onUpdateStateEVENT : String = "onUpdateState";

		
		//--------------------------------------------------------------------
		// Public properties
		//--------------------------------------------------------------------
		
		/** Font file path. */
		public var path : String;

		/** Font properties modification state. */
		public var modified : Boolean; 

		
		//--------------------------------------------------------------------
		// Public API
		//--------------------------------------------------------------------
		
		/**
		 * Creates a new <code>LibraryStateEvent</code> instance.
		 * 
		 * @param	type		name of the event type
		 * @param	path		font path
		 * @param	modified	font modification state
		 */
		public function LibraryStateEvent(type : String, path : String, modified : Boolean)
		{
			super(type);
			
			this.path = path;
			this.modified = modified;
		}
	}
}
